User
# List User Information
Request
GET /openapi/users?pageSize=<pageSize>&pageNum=<pageNum>&account=<account>
1
Query Parameter Description
| Parameter Name | Description | Type | Required |
|---|---|---|---|
pageNum | Page number | int | Yes |
pageSize | Number per page | int | Yes |
account | Account keyword | string | No |
identity_type | Identity type; required when integrating external account systems, such as ldap, lark, oauth, dingtalk, workwx | string | No |
Success Response Description
| Parameter Name | Type | Description |
|---|---|---|
users | []User | User list |
total | int | Total users |
User Parameter Description
| Parameter Name | Description | Type |
|---|---|---|
uid | UID | string |
name | Username | string |
accout | Account name | string |
Success Response Example
{
"users": [
{
"uid": "ddd405d5-5131-11ee-b458-4a4088364d94",
"account": "admin",
"name": "admin"
},
{
"uid": "d456d705-73a9-11ee-98cf-56ef622fc735",
"account": "demo",
"name": "demo"
}
],
"total_count": 2
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# List User Group Information
Request
GET /openapi/user-groups?pageNum=<PageNum>&pageSize=<PageSize>
1
Query Parameter Description
| Parameter Name | Type | Description | Required |
|---|---|---|---|
pageNum | int | Page number | Yes |
pageSize | int | Number per page | Yes |
Success Response Description
| Parameter Name | Description | Type |
|---|---|---|
uid | UID | string |
name | Username | string |
accout | Account name | string |
Success Response Example
{
"group_list": [
{
"id": "98256be6-6e53-11ee-a205-9653dd3e9c32",
"name": "user-group1",
"description": "user-group description",
"type": "custom",
"user_total": 1
},
{
"id": "cce58580-5131-11ee-b458-4a4088364d94",
"name": "All Users",
"description": "All users in the system",
"type": "system",
"user_total": 11
}
],
"total": 2
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Delete User
Request
DELETE /openapi/users/:uid
1
Parameter description
| Parameter Name | Description | Type |
|---|---|---|
uid | string | 用户 uid |
Response
{
"message": "success"
}
1
2
3
2
3
